Skip to content

chore(deps, internal docs): Add usage method to VRL functions#24504

Merged
thomasqueirozb merged 2 commits intomasterfrom
add-usage-to-vrl-functions
Jan 20, 2026
Merged

chore(deps, internal docs): Add usage method to VRL functions#24504
thomasqueirozb merged 2 commits intomasterfrom
add-usage-to-vrl-functions

Conversation

@thomasqueirozb
Copy link
Contributor

@thomasqueirozb thomasqueirozb commented Jan 15, 2026

Summary

  1. Bumps VRL.
  2. Implements the usage method for all VRL functions by adding descriptions from the corresponding cue files in website/cue/reference/remap/functions/.
  3. Adds const-str as a workspace dependency to enable compile-time string concatenation for usage descriptions with shared explainers.

Vector configuration

NA

How did you test this PR?

Verified with cargo check

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

@thomasqueirozb thomasqueirozb changed the title chore(deps, docs): Add usage method to VRL functions chore(deps, internal docs): Add usage method to VRL functions Jan 15, 2026
@thomasqueirozb thomasqueirozb added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 15, 2026
@thomasqueirozb thomasqueirozb marked this pull request as ready for review January 15, 2026 22:21
@thomasqueirozb thomasqueirozb requested a review from a team as a code owner January 15, 2026 22:21
]
}

pub(crate) const ENRICHMENT_TABLE_EXPLAINER: &str = indoc! {r#"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A good first start. I'm thinking we can add something simpler like a few examples that people can follow (and also for LLMs to train on) that would be easier than trying to wade through the technical docs/specs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just copied over but I think a new page on just enrichment tables w/ simple examples is definitely not a bad idea

@thomasqueirozb thomasqueirozb added this pull request to the merge queue Jan 20, 2026
Merged via the queue into master with commit a3bb693 Jan 20, 2026
119 checks passed
@thomasqueirozb thomasqueirozb deleted the add-usage-to-vrl-functions branch January 20, 2026 21:56
@github-actions github-actions bot locked and limited conversation to collaborators Jan 20, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants